<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
<!-- qtgui-qdocconf.qdoc -->
  <title>Qtgui.qdocconf with notes | QDoc Manual 5.14.2</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td ><a href="../qtdoc/index.html">Qt 5.14</a></td><td ><a href="qdoc-index.html">QDoc Manual</a></td><td >Qtgui.qdocconf with notes</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qdoc-index.html">Qt 5.14.2 Reference Documentation</a></td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Qtgui.qdocconf with notes</h1>
<span class="subtitle"></span>
<!-- $$$qtgui-qdocconf.html-description -->
<div class="descr"> <a name="details"></a>
<p>This document goes through a typical Qt 5 qdocconf file. The contents is taken from Qt GUI's <i>qtgui.qdocconf</i> file.</p>
<p>Below you will find the full contents of <code>qtgui.qdocconf</code>. The subsequent section will discuss every statement in the qdocconf file.</p>
<pre class="cpp plain">

  include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)

  project                 = QtGui
  description             = Qt GUI Reference Documentation
  url                     = http://doc.qt.io/qt-5
  version                 = $QT_VERSION

  examplesinstallpath     = gui

  qhp.projects            = QtGui

  qhp.QtGui.file         = qtgui.qhp
  qhp.QtGui.namespace           = org.qt-project.qtgui.$QT_VERSION_TAG
  qhp.QtGui.virtualFolder       = qtgui
  qhp.QtGui.indexTitle          = Qt GUI
  qhp.QtGui.indexRoot           =

  qhp.QtGui.filterAttributes    = qtgui $QT_VERSION qtrefdoc
  qhp.QtGui.customFilters.Qt.name = Qtgui $QT_VERSION
  qhp.QtGui.customFilters.Qt.filterAttributes = qtgui $QT_VERSION

  qhp.QtGui.subprojects         = classes
  qhp.QtGui.subprojects.classes.title = C++ Classes
  qhp.QtGui.subprojects.classes.indexTitle = Qt GUI C++ Classes
  qhp.QtGui.subprojects.classes.selectors = class fake:headerfile
  qhp.QtGui.subprojects.classes.sortPages = true

  tagfile                 = ../&#x2e;./&#x2e;./doc/qtgui/qtgui.tags

  depends += \
      qtcore \
      qtnetwork \
      qtopengl \
      qtsvg \
      qtqml \
      qtquick \
      qtwidgets \
      qtdoc

  headerdirs  += ..

  sourcedirs  += .. \
                 ../&#x2e;./&#x2e;./examples/gui/doc/src

  excludedirs  = ../&#x2e;./&#x2e;./examples/gui/doc/src/tmp

  exampledirs += ../&#x2e;./&#x2e;./examples/gui \
                 snippets

  imagedirs   += images \
                 ../&#x2e;./&#x2e;./examples/gui/doc/images \
                 ../&#x2e;./&#x2e;./doc/src/images \

</pre>
<pre class="cpp plain">

  include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)

</pre>
<p>QDoc inherits the default templates, macros, and settings from the directory specified from the <code>$QT_INSTALL_DOCS</code> variable. <code>qmake</code> prints the value of the variable.</p>
<pre class="cpp plain">

  qmake -query

</pre>
<p><b>See also</b>: <a href="12-0-qdoc-commands-miscellaneous.html#include">include</a>.</p>
<pre class="cpp plain">

  project                 = QtGui

</pre>
<p>The <code>project</code> variable sets the name of the QDoc build. This name is also used to form the index file, which, in this case, will be <i>qtgui.index</i>. The name of the index file doesn't adopt the uppercase letters of the project name.</p>
<p><b>See also</b>: <a href="25-qdoc-configuration-derivedprojects.html#project">project</a>.</p>
<pre class="cpp plain">

  description             = Qt GUI Reference Documentation

</pre>
<p>A short description of the project concerned.</p>
<pre class="cpp plain">

  url                     = http://doc.qt.io/qt-5

</pre>
<p>The <code>url</code> variable holds the base url of the project.</p>
<p>The URL is stored in the generated index file for the project. QDoc will use this as the base URL when constructing external links to content listed in the index.</p>
<p><b>Note: </b>QDoc omits this value when the -installdir argument is specified when running QDoc.</p><a name="examplesinstallpath"></a><pre class="cpp plain">

  examplesinstallpath     = gui

</pre>
<p>This <code>examplesinstallpath</code> variable indicates that the examples will be installed in the <i>gui</i> directory under the parent examples directory (for Qt, this is $QT_INSTALL_EXAMPLES).</p>
<p><b>Note: </b>The examplepath variable has to match the example directory specified in <code>exampledirs</code>.</p><p><b>Note: </b>It is possible to override the <code>exampleinstallpath</code> for a specific <a href="13-qdoc-commands-topics.html#example-command">\example</a> using the <a href="12-0-qdoc-commands-miscellaneous.html#meta-command">\meta</a> command.</p><p><b>See also</b>: <a href="22-qdoc-configuration-generalvariables.html#exampledirs">exampledirs</a> and <a href="12-0-qdoc-commands-miscellaneous.html#meta-command">\meta</a>.</p>
<pre class="cpp plain">

  qhp.projects    = QtGui
  qhp.QtGui.file  = qtgui.qhp

</pre>
<p>The following parameters are for creating a QHP file (<i>.qhp</i>). The <i>qhelpgenerator</i> program can convert the QHP file into a QCH file (<i>.qch</i>), which can be opened in Qt Assistant or Qt Creator.</p>
<pre class="cpp plain">

  qhp.QtGui.namespace           = org.qt-project.qtgui.$QT_VERSION_TAG

</pre>
<p>A unique identifier which enables <a href="../qthelp/qhelpengine.html">QHelpEngine</a> to retrieve the helpfile from a given link. This namespace is also used as a base url for links to the helpfile.</p>
<pre class="cpp plain">

  qhp.QtGui.virtualFolder       = qtgui

</pre>
<p>Virtual folders group documentation together into a single location. A virtual folder will become the root directory of all files referenced in a compressed help file.</p>
<p>When two manuals are located in the same virtual folder, it is possible to refer to sections of the other manual using relative paths. The virtual folder tag is mandatory and the folder must not contain any '/'.</p>
<pre class="cpp plain">

  qhp.QtGui.indexTitle          = Qt GUI

</pre>
<p>This is the title of the page that has the contents.</p>
<pre class="cpp plain">

  qhp.QtGui.indexRoot           =

</pre>
<p>Specifies the title of the root (namespace) page to generate the documentation for. Typically defined as an empty string.</p>
<pre class="cpp plain">

  qhp.QtGui.filterAttributes    = qtgui $QT_VERSION qtrefdoc
  qhp.QtGui.customFilters.Qt.name = QtGui $QT_VERSION
  qhp.QtGui.customFilters.Qt.filterAttributes = qtgui $QT_VERSION

</pre>
<p>The documentation set (one per QDoc project) can have any number of filter attributes assigned to it. A filter attribute is an ordinary string which can be freely chosen. Additionally, custom filters that reference above attributes can be defined. Qt Assistant will display the name of the custom filter in its <b>Filtered by</b> drop-down list. Only the documentation sets that have their filter attributes match the attributes of the selected custom filter will be shown.</p>
<pre class="cpp plain">

  qhp.QtGui.subprojects         = classes
  qhp.QtGui.subprojects.classes.title = C++ Classes
  qhp.QtGui.subprojects.classes.indexTitle = Qt GUI C++ Classes

</pre>
<p>The subprojects specify the sections that are displayed in the table of contents for this project. In this example, the subproject, which is displayed in the Assistant's sidebar, is named &quot;C++ Classes&quot; and its index is the page titled &quot;QT GUI C++ Classes&quot;.</p>
<pre class="cpp plain">

  qhp.QtGui.subprojects.classes.selectors = class fake:headerfile

</pre>
<p>Lists all C++ classes and header files.</p>
<p>See <a href="22-creating-help-project-files.html">Creating Help Project Files</a> for more information.</p>
<pre class="cpp plain">

  tagfile                 = ../&#x2e;./&#x2e;./doc/qtgui/qtgui.tags

</pre>
<p>This specifies the Doxygen tag file that needs to be written when the html is generated by QDoc.</p>
<pre class="cpp plain">

  depends += \
     qtcore \
     qtnetwork \
     qtopengl \
     qtsvg \
     qtqml \
     qtquick \
     qtwidgets \
     qtdoc

</pre>
<p>Specifies the modules QDoc needs to load for generating output for Qt GUI. QDoc loads the index files for all modules listed in the depends statement in order to enable linking to pages in these modules.</p>
<pre class="cpp plain">

  headerdirs  += ..

</pre>
<p>Add the parent directory to the list of directories containing the header files associated with the <i>.cpp</i> source files.</p>
<pre class="cpp plain">

  sourcedirs  += .. \
                 ../&#x2e;./&#x2e;./examples/gui/doc/src

</pre>
<p>Add the specified directories to the list of directories containing the <i>.cpp</i> and <i>.qdoc</i> files used in the documentation.</p>
<pre class="cpp plain">

  excludedirs  = ../&#x2e;./&#x2e;./examples/gui/doc/src/tmp

</pre>
<p>The <code>excludedirs</code> variable is for listing directories that should not be processed by qdoc, even if the same directories are included by the <code>sourcedirs</code> or <code>headerdirs</code> variables.</p>
<p>When executed, QDoc will ignore the directories listed. <b>See also</b>: <a href="22-qdoc-configuration-generalvariables.html#excludefiles">excludefiles</a>.</p>
<pre class="cpp plain">

  exampledirs += ../&#x2e;./&#x2e;./examples/gui \
                 snippets

</pre>
<p><b>See also</b>: <a href="22-qdoc-configuration-generalvariables.html#examples-variable">examples</a>, <a href="qtgui-qdocconf.html#examplesinstallpath">examplesinstallpath</a>.</p>
<p>Add the two directories specified to the list of directories containing the source code of the example files.</p>
<p>If QDoc encounters both <code>exampledirs</code> and <code>examples</code>, it will look first in the <code>examples</code> directory. QDoc will accept the first matching file it finds. QDoc will search in the directories specified, not in their subdirectories.</p>
<pre class="cpp plain">

  imagedirs   += images \
                 ../&#x2e;./&#x2e;./examples/gui/doc/images \
                 ../&#x2e;./&#x2e;./doc/src/images \

</pre>
<p>Add the directories specified above to the list of directories where the images can be found.</p>
</div>
<!-- @@@qtgui-qdocconf.html -->
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2020 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br/>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br/>    Qt and respective logos are trademarks of The Qt Company Ltd.     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>
